<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<link href="../css/docs.css" type="text/css" rel="stylesheet"/>
<link href="../css/prettify.css" type="text/css" rel="stylesheet"/>
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
  <div id="api-info-block">
    <div class="api-level">H3C CAS云管理平台</div>
  </div>
  <div id="jd-header">
    <h1>查询指定虚拟机网络信息</h1>
  </div>
  <div id="jd-content">
    <div class="jd-descr">
      <p>根据虚拟机id查询指定虚拟机的网络信息。</p>

      <h2><a name="uri"></a>接口 URI</h2>
      <p>/cas/casrs/vm/network/{id}</p>

      <h2><a name="access"></a>访问方法</h2>
      <dl>
        <dt><b>HTTP 方法</b></dt>
        <dd>GET</dd>
        <dt><b>参数</b></dt>
        <table id="pubmethods" class="jd-sumtable"><tbody><tr>
          <th colspan="2">路径参数（Path Parameter）</th>
        </tr>
	        
	        <tr >
	          <td class="jd-typecol"><span class="prettyprint lang-xml">id</span></td>
	          <td class="jd-linkcol" width="100%">
	            <span class="sympad">虚拟机id 。</span>
              <div class="jd-descrdiv">长整数（long）类型。必须，无缺省值。</div>	          </td>
	        </tr>
        </table>
      </dl>

      <h2><a name="result"></a>返回结果</h2>
      <dl>
      	<dt><b>状态码</b></dt>
    		<dd><ul>
    			<li>200(OK)：成功。</li>
    		</ul></dd>

	      <dt><b>消息头</b></dt>	      
	      <div class="source">
	        <pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
</pre>
	      </div>

        <dt><b>消息体</b></dt>
        <div class="source">
          <pre class="prettyprint lang-xml">&lt;list&gt;<br>  &lt;network&gt;<br>    &lt;mac&gt;02:36:b8:a5:f2:3d&lt;/mac&gt;<br>    &lt;ipAddr&gt;192.168.0.253&lt;/ipAddr&gt;<br>    &lt;vsName&gt;vswitch0&lt;/vsName&gt;<br>    &lt;vlan&gt;0&lt;/vlan&gt;<br>    &lt;isLimitInBound&gt;false&lt;/isLimitInBound&gt;<br>    &lt;isLimitOutBound&gt;false&lt;/isLimitOutBound&gt;<br>    &lt;mode&gt;VEB&lt;/mode&gt;<br>    &lt;virtualport&gt;false&lt;/virtualport&gt;<br>  &lt;/network&gt;<br>  &lt;network&gt;<br>    &lt;mac&gt;02:36:b8:c4:db:a6&lt;/mac&gt;<br>    &lt;vsName&gt;vs3&lt;/vsName&gt;<br>    &lt;vlan&gt;20&lt;/vlan&gt;<br>    &lt;isLimitInBound&gt;false&lt;/isLimitInBound&gt;<br>    &lt;isLimitOutBound&gt;false&lt;/isLimitOutBound&gt;<br>    &lt;mode&gt;VEPA&lt;/mode&gt;<br>    &lt;virtualport&gt;false&lt;/virtualport&gt;<br>  &lt;/network&gt;<br>&lt;/list&gt;
          </pre>
        </div>
      <dt><a name="detail"></a><b>元素含义</b></dt>
        <table id="pubmethods" class="jd-sumtable">
	      <tbody>
	        <tr>
	          <th colspan="2"><span class="prettyprint lang-xml">network</span>各子元素</th>
            <tr>
              <td class="jd-typecol"><span class="prettyprint lang-xml">mac</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">网卡MAC地址。</span>
                  <div class="jd-descrdiv">字符串（String）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">ipAddr</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">网卡IP地址。</span>
                  <div class="jd-descrdiv">字符串（String）类型。</div></td>
            </tr>
            <tr >
              <td class="jd-typecol"><span class="prettyprint lang-xml">vsName</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">网卡</span>使用的虚拟交换机名称<span class="sympad">。</span>
                  <div class="jd-descrdiv">字符串（String）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">vlan</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">网卡所属的VLAN。</span>
                  <div class="jd-descrdiv">整数（int）类型。</div></td>
            </tr>
            <tr>
              <td class="jd-typecol"><span class="prettyprint lang-xml">isLimitInBound</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">是否限制入方向带宽。 true：限制 false：不限制。</span>
                  <div class="jd-descrdiv">布尔（boolean）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">inAvgBandwidth</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">入方向平均带宽。</span>
                  单位（kbps）。
                  <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr >
              <td class="jd-typecol"><span class="prettyprint lang-xml">inPeakBandwidth</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">入方向峰值带宽。</span>单位（kbps）。
              <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">inBurst</span></td>
              <td class="jd-linkcol" width="100%"><span class="sympad">入方向突发缓冲大小。
                  单位（kBytes）。</span>
                  <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr>
              <td class="jd-typecol"><span class="prettyprint lang-xml">isLimitOutBound</span></td>
              <td class="jd-linkcol"><span class="sympad">是否限制出方向带宽。 true：限制 false：不限制。</span>
                  <div class="jd-descrdiv">布尔（boolean）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">outAvgBandwidth</span></td>
              <td class="jd-linkcol"><span class="sympad">出方向平均带宽。</span> 单位（kbps）。
              <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr >
              <td class="jd-typecol"><span class="prettyprint lang-xml">outPeakBandwidth</span></td>
              <td class="jd-linkcol"><span class="sympad">出方向峰值带宽。</span>单位（kbps）。
              <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">outBurst</span></td>
              <td class="jd-linkcol"><span class="sympad">出方向突发缓冲大小。
                单位（kBytes）。</span>
                  <div class="jd-descrdiv">长整数（long）类型。</div></td>
            </tr>
            <tr >
              <td class="jd-typecol"><span class="prettyprint lang-xml">mode</span></td>
              <td class="jd-linkcol"><span class="sympad">转发模式。</span><div class="jd-descrdiv">字符串（String）类型。</div></td>
            </tr>
			<tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">virtualport</span></td>
              <td class="jd-linkcol"><span class="sympad">是否配置了vport。true:配置 false:未配置</span>
              <div class="jd-descrdiv">布尔（boolean）类型。</div></td>
            </tr>
			<tr >
              <td class="jd-typecol"><span class="prettyprint lang-xml">address</span></td>
              <td class="jd-linkcol"><span class="sympad">物理网卡直连或者SR-IOV直连的地址。</span>
			  <div class="jd-descrdiv">字符串（String）类型。</div></td>
            </tr>
			<tr class="alt-color">
              <td class="jd-typecol"><span class="prettyprint lang-xml">netType</span></td>
              <td class="jd-linkcol"><span class="sympad">网卡类型：0：桥接 1：NAT 2：不使用网络 3：物理直通网卡  4：SR-IOV网卡。</span>
			  <div class="jd-descrdiv">整数（int）类型。</div></td>
            </tr>
        </table>
	    <dt>&nbsp;</dt>
      </dl>
      

      <h2><a name="example"></a>应用举例</h2>
      <p>查询 ID为”52“的虚拟机网络信息。</p>
      <dl>
      	<dt><b>请求</b></dt>
        <div class="source">
          <pre class="prettyprint lang-xml">
GET http://localhost:8080/cas/casrs/vm/network/52
accept: application/xml
...        </pre>
        </div>
      	<dt><b>回应</b></dt>
        <div class="source">
          <pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Content-Type: application/xml
...
&lt;list&gt;<br>  &lt;network&gt;<br>    &lt;mac&gt;02:36:b8:a5:f2:3d&lt;/mac&gt;<br>    &lt;ipAddr&gt;192.168.0.253&lt;/ipAddr&gt;<br>    &lt;vsName&gt;vswitch0&lt;/vsName&gt;<br>    &lt;vlan&gt;0&lt;/vlan&gt;<br>    &lt;isLimitInBound&gt;false&lt;/isLimitInBound&gt;<br>    &lt;isLimitOutBound&gt;false&lt;/isLimitOutBound&gt;<br>    &lt;mode&gt;VEB&lt;/mode&gt;<br>    &lt;virtualport&gt;false&lt;/virtualport&gt;<br>  &lt;/network&gt;<br>  &lt;network&gt;<br>    &lt;mac&gt;02:36:b8:c4:db:a6&lt;/mac&gt;<br>    &lt;vsName&gt;vs3&lt;/vsName&gt;<br>    &lt;vlan&gt;20&lt;/vlan&gt;<br>    &lt;isLimitInBound&gt;false&lt;/isLimitInBound&gt;<br>    &lt;isLimitOutBound&gt;false&lt;/isLimitOutBound&gt;<br>    &lt;mode&gt;VEPA&lt;/mode&gt;<br>    &lt;virtualport&gt;false&lt;/virtualport&gt;<br>  &lt;/network&gt;<br>&lt;/list&gt;<br>
          </pre>
        </div>
      </dl>
  </div>
  </div>
</div>
</body>
</html>